home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / man.3 / SetVar.3 < prev    next >
Text File  |  1995-07-17  |  11KB  |  348 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/SetVar.3,v 1.15 93/06/05 15:40:17 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS Tcl_SetVar tclc 7.0
  206. .BS
  207. .SH NAME
  208. Tcl_SetVar, Tcl_SetVar2, Tcl_GetVar, Tcl_GetVar2, Tcl_UnsetVar, Tcl_UnsetVar2 \- manipulate Tcl variables
  209. .SH SYNOPSIS
  210. .nf
  211. \fB#include <tcl.h>\fR
  212. .sp
  213. char *
  214. \fBTcl_SetVar\fR(\fIinterp, varName, newValue, flags\fR)
  215. .sp
  216. char *
  217. \fBTcl_SetVar2\fR(\fIinterp, name1, name2, newValue, flags\fR)
  218. .sp
  219. char *
  220. \fBTcl_GetVar\fR(\fIinterp, varName, flags\fR)
  221. .sp
  222. char *
  223. \fBTcl_GetVar2\fR(\fIinterp, name1, name2, flags\fR)
  224. .sp
  225. int
  226. \fBTcl_UnsetVar\fR(\fIinterp, varName, flags\fR)
  227. .sp
  228. int
  229. \fBTcl_UnsetVar2\fR(\fIinterp, name1, name2, flags\fR)
  230. .SH ARGUMENTS
  231. .AS Tcl_Interp *newValue
  232. .AP Tcl_Interp *interp in
  233. Interpreter containing variable.
  234. .AP char *varName in
  235. Name of variable.  May refer to a scalar variable or an element of
  236. an array variable.
  237. .AP char *newValue in
  238. New value for variable.
  239. .AP int flags in
  240. OR-ed combination of bits providing additional information for
  241. operation. See below for valid values.
  242. .AP char *name1 in
  243. Name of scalar variable, or name of array variable if \fIname2\fR
  244. is non-NULL.
  245. .AP char *name2 in
  246. If non-NULL, gives name of element within array and \fIname1\fR
  247. must refer to an array variable.
  248. .BE
  249.  
  250. .SH DESCRIPTION
  251. .PP
  252. These procedures may be used to create, modify, read, and delete
  253. Tcl variables from C code.
  254. \fBTcl_SetVar\fR and \fBTcl_SetVar2\fR will create a new variable
  255. or modify an existing one.
  256. Both of these procedures set the given variable to the value
  257. given by \fInewValue\fR, and they return a pointer to a
  258. copy of the variable's new value, which is stored in Tcl's
  259. variable structure.
  260. Tcl keeps a private copy of the variable's value, so the caller
  261. may change \fInewValue\fR after these procedures return without
  262. affecting the value of the variable.
  263. If an error occurs in setting the variable (e.g. an array
  264. variable is referenced without giving an index into the array),
  265. then NULL is returned.
  266. .PP
  267. The name of the variable may be specified in either of two ways.
  268. If \fBTcl_SetVar\fR is called, the variable name is given as
  269. a single string, \fIvarName\fR.
  270. If \fIvarName\fR contains an open parenthesis and ends with a
  271. close parenthesis, then the value between the parentheses is
  272. treated as an index (which can have any string value) and
  273. the characters before the first open
  274. parenthesis are treated as the name of an array variable.
  275. If \fIvarName\fR doesn't have parentheses as described above, then
  276. the entire string is treated as the name of a scalar variable.
  277. If \fBTcl_SetVar2\fR is called, then the array name and index
  278. have been separated by the caller into two separate strings,
  279. \fIname1\fR and \fIname2\fR respectively;  if \fIname2\fR is
  280. zero it means that a scalar variable is being referenced.
  281. .PP
  282. The \fIflags\fR argument may be used to specify any of several
  283. options to the procedures.
  284. It consists of an OR-ed combination of any of the following
  285. bits:
  286. .IP TCL_GLOBAL_ONLY
  287. Under normal circumstances the procedures look up variables
  288. at the current level of procedure call for \fIinterp\fR, or
  289. at global level if there is no call active.
  290. However, if this bit is set in \fIflags\fR then the variable
  291. is looked up at global level even if there is a procedure
  292. call active.
  293. .IP TCL_LEAVE_ERR_MSG
  294. If an error is returned and this bit is set in \fIflags\fR, then
  295. an error message will be left in \fI\%interp->result\fR.  If this
  296. flag bit isn't set then no error message is left (\fI\%interp->result\fR
  297. will not be modified).
  298. .IP TCL_APPEND_VALUE
  299. If this bit is set then \fInewValue\fR is appended to the current
  300. value, instead of replacing it.
  301. If the variable is currently undefined, then this bit is ignored.
  302. .IP TCL_LIST_ELEMENT
  303. If this bit is set, then \fInewValue\fR is converted to a valid
  304. Tcl list element before setting (or appending to) the variable.
  305. A separator space is appended before the new list element unless
  306. .VS
  307. the list element is going to be the first element in a list or
  308. sublist (i.e. the variable's current value is empty, or contains
  309. the single character ``{'', or ends in `` }'').
  310. .VE
  311. .PP
  312. \fBTcl_GetVar\fR and \fBTcl_GetVar2\fR return the current value
  313. of a variable.
  314. The arguments to these procedures are treated in the same way
  315. as the arguments to \fBTcl_SetVar\fR and \fBTcl_SetVar2\fR.
  316. Under normal circumstances, the return value is a pointer
  317. to the variable's value (which is stored in Tcl's variable
  318. structure and will not change before the next call to \fBTcl_SetVar\fR
  319. or \fBTcl_SetVar2\fR).
  320. The only bits of \fIflags\fR that are used are TCL_GLOBAL_ONLY
  321. and TCL_LEAVE_ERR_MSG, both of
  322. which have
  323. the same meaning as for \fBTcl_SetVar\fR.
  324. If an error occurs in reading the variable (e.g. the variable
  325. doesn't exist or an array element is specified for a scalar
  326. variable), then NULL is returned.
  327. .PP
  328. \fBTcl_UnsetVar\fR and \fBTcl_UnsetVar2\fR may be used to remove
  329. a variable, so that future calls to \fBTcl_GetVar\fR or \fBTcl_GetVar2\fR
  330. for the variable will return an error.
  331. The arguments to these procedures are treated in the same way
  332. as the arguments to \fBTcl_GetVar\fR and \fBTcl_GetVar2\fR.
  333. .VS
  334. If the variable is successfully removed then TCL_OK is returned.
  335. If the variable cannot be removed because it doesn't exist then
  336. TCL_ERROR is returned.
  337. .VE
  338. If an array element is specified, the given element is removed
  339. but the array remains.
  340. If an array name is specified without an index, then the entire
  341. array is removed.
  342.  
  343. .SH "SEE ALSO"
  344. Tcl_TraceVar
  345.  
  346. .SH KEYWORDS
  347. array, interpreter, scalar, set, unset, variable
  348.